home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / ecf100.zip / ECHOFIX.DOC next >
Text File  |  1997-08-22  |  7KB  |  173 lines
  1.                      ┌──────────────────────────────────────┐
  2.                      │            EchoFix v 1.01            │
  3.                      │                                      │
  4.                      │            Copyright 1997            │
  5.                      │          Gnome Enterprises           │
  6.                      │         Author : David Chord         │
  7.                      └──────────────────────────────────────┘
  8.  
  9. EchoFix is a program designed to aid Maximus SysOp's in maintaining their
  10. message areas on their system.
  11.  
  12. It works by reading in your SQUISH.CFG file, and comparing the echo area tags
  13. with those in your MSGAREA.CTL file. If an area is found in SQUISH.CFG that
  14. does not appear in MSGAREA.CTL, a file named MSGAREA.ECF is created in your
  15. MSGAREA.CTL directory, and the area's details are written into this file in the
  16. Maximus version 3.x format.
  17.  
  18. CREDITS
  19.  
  20. Much thanks is owed to Michael McGavin, my main (and with this program, only)
  21. beta tester, without whom this program would be full of bugs and the
  22. documentation full of errers.
  23.  
  24. WARRANTY
  25.  
  26. This program has been extensively tested to make sure there are no bugs.
  27. However, since we cannot control the SQ (Stupidity Quotient) of people,
  28. including ourselves, we cannot and will not be held responsible for any
  29. problems resulting in loss of sight, limb or data that occur while you are
  30. using this program. It is up to you to make sure that you run regular backups
  31. of your system and that you use this program only as detailed in this document.
  32.  
  33. COST
  34.  
  35. This program is freeware. However, if you like it, a small donation to keep
  36. Gnome Enterprises running would be greatly appreciated.
  37.  
  38. Send any donations to :
  39. David Chord
  40. PO Box 53053
  41. Cannons Creek
  42. Porirua
  43. New Zealand
  44.  
  45. GENERAL
  46.  
  47. This program makes a few assumptions about you and your system, these being :
  48.  
  49.    ■   You're not to lazy to sort out your local areas yourself.
  50.  
  51.    ■   When you defined each area in MSGAREA.CTL, you remembered to include the
  52.        TAG line for use with the ECHOTOSS.LOG file.
  53.  
  54.    ■   The default address defined in Maximus and the default address defined
  55.        in Squish are the same.
  56.  
  57.    ■   For those areas that use an address other than your default one, you've
  58.        used the '-p<address>' switch in Squish.
  59.  
  60. HOW IT WORKS
  61.  
  62. EchoFix works by scanning your SQUISH.CFG file for the ECHOAREA lines,
  63. breaking the line into seperate parts (Area Tag, Area Path, Area Type and
  64. Area Address), then reading your MSGAREA.CTL file for a matching area TAG.
  65.  
  66. If the TAG is not found, EchoFix creates a file named MSGAREA.ECF in the same
  67. directory that MSGAREA.CTL is in, then adds each missing area to MSGAREA.ECF.
  68.  
  69. The new areas are in the format :
  70.  
  71. MsgArea INTBBS_WK
  72.        Acs              Normal
  73.        Desc             INTBBS_WK
  74.        Path             D:\MAX\MSG\INTBBS_W
  75.        Style            Pub Echo RealName Squish
  76.        Tag              INTBBS_WK
  77.  
  78.        Origin           .  .  Your Origin Line
  79. End MsgArea
  80.  
  81. For those areas that are defined as *.MSG in SQUISH.CFG, the 'Style' line will
  82. become :
  83.  
  84.        Style            Pub Echo Realname *.MSG
  85.  
  86. If you've used a different address for an area in SQUISH.CFG, eg
  87.  
  88. EchoArea  INTBBS_WK  D:\MAX\MSG\INTBBS_WK  -$m500 -p28:1500/1 3:771/1560.0
  89.  
  90. (where the '-p28:1500/1' tells squish to use 28:1500/1 as the origin
  91. address) then the origin line will become
  92.  
  93.        Origin           28:1500/1  28:1500/1  Your Origin Line
  94.  
  95. It is up to you to check each area is correct, add in the description for the
  96. area, and make sure the are Style and Acs are correct.
  97.  
  98. There is an option to point ECHOFIX to your SQAFIX.CFG file, from where it will
  99. extract descritpions for you. This is only usefull if the bulk of your
  100. descriptions in SQAFIX.CFG are correct. Also, please note that this adds a lot
  101. of extra work to EchoFix, and it will run noteably slower if you are using this
  102. option - if you only have a few areas to add it would probably be best to
  103. simply type the descriptions in by hand after running EchoFix
  104.  
  105. As each area will be in the same format, it is simple to make global changes to
  106. the entire file, eg replacing 'Your Origin Line' with the origin line you wish
  107. to use.
  108.  
  109. USAGE :
  110.  
  111. Usage of EchoFix is very simple. EchoFix takes in 2 or 3 command line
  112. parameters, these being the path/name of your MSGAREA.CTL file, the path/name
  113. of your SQUISH.CFG file, and optionally the path/name of your SQAFIX.CFG file,
  114. eg
  115.  
  116.   ECHOFIX D:\MAX\MSGAREA.CTL D:\MAX\SQUISH\SQUISH.CFG
  117.  
  118. would tell EchoFix to use the MSGAREA.CTL file in D:\MAX, and the SQUISH.CFG
  119. file in D:\MAX\SQUISH, or
  120.  
  121.   ECHOFIX  D:\MAX\MSGAREA.CTL  D:\SQUISH\SQUISH.CFG  D:\SQAFIX\SQAFIX.CFG
  122.  
  123. would tell EchoFix to use the MSGAREA.CTL file in D:\MAX, the SQUISH.CFG file
  124. in D:\SQUISH, and the SQAFIX.CFG file in D:\SQAFIX.
  125.  
  126. After EchoFix is run, edit the resulting MSGAREA.ECF file and make any
  127. necessary alterations to the file, then merge the MSGAREA.ECF file with your
  128. current MSGAREA.CTL file.
  129.  
  130. NOTE that is is up to YOU to make sure the access levels and addresses/origin
  131. lines used in the areas are correct. The only thing EchoFix can do for sure is
  132. make an area who's name and TAG match an ECHOAREA in SQUISH.CFG.
  133.  
  134. Naturally, it is a good idea to back up all your files often, especially if you
  135. are going to be changing them.
  136.  
  137. SPEED
  138.  
  139. EchoFix V1.x includes several examples of optimized code, as well as some other
  140. features that have improved the speed of EchoFix over earlier versions.
  141. However, in some situations it will still appear to run slow.
  142.  
  143. If you have a large system, with a lot of areas already defined in MSGAREA.CTL,
  144. and are using the SQAFIX option, again with a lot of areas, the overall speed
  145. of EchoFix will drop with the more areas each of these files has. If your
  146. system is something like this, and you only want to add a couple of new areas,
  147. then you're best to get off your lazy backside and type them in manually, as it
  148. probably will be faster. If you're wanting to add 20 or 30 areas, then EchoFix
  149. should save you a considerable amount of time.
  150.  
  151. If you have lost your MSGAREA.CTL file for some reason, EchoFix can build it
  152. for you from scratch, but the file MSGAREA.CTL MUST exist somewhere for EchoFix
  153. to start, even if it's a 0-length file. Running like this, EchoFix will move
  154. pretty fast. My machine's record is 388 areas added to an empty MSGARAEA.CTL in
  155. 1 minute 50 seconds (compare with 27minutes 43 seconds for EchoFix 0.24 using
  156. the same files).
  157.  
  158. Naturally, the further into either MSGAREA.CTL or SQAFIX.CFG EchoFix has to
  159. read, the slower it will run.
  160.  
  161. BUGS
  162.  
  163. If you have any suggestions for improcements to EchoFix, or you find any bugs
  164. or error codes that we haven't trapped in some way, please send as much
  165. information on the problem as you can to :
  166.  
  167. David Chord, 170:1701/110@tfnet.ftn
  168. David Chord, 3:771/1560@fidonet.org
  169. david.chord@cobra.galaxy.gen.nz
  170.  
  171. Please include details about your system including environment and versions of
  172. software used.
  173.